Skip to main content

Webhook: TASK_EXPIRED

Description​

The TASK_EXPIRED webhook is triggered when a task remains incomplete after its allocated execution time has elapsed. This webhook helps ensure that systems or users are informed about overdue tasks for better follow-up or remediation.

Request Format​

The webhook is sent as an HTTP POST request with the following payload:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_EXPIRED",
   "createdAt": "2024-12-16T09:43:01.347Z",
   "data": {
      "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T09:00:00.000Z",
      "endAt": "2024-12-16T09:43:00.000Z",
      "name": "Task 2",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": null,
      "actionId": null
   }
}

Key Properties​

Top-Level Properties​

  • entityId: Unique identifier for the expired task.
  • type: Specifies the type of webhook (TASK_EXPIRED).
  • createdAt: Timestamp indicating when the webhook was triggered (in ISO 8601 format).

Data Section​

Contains detailed information about the expired task:

  • id: Unique identifier for the task.
  • organizationId: ID of the organization associated with the task.
  • locationId: ID of the location where the task was assigned.
  • startAt: Start time of the task in ISO 8601 format.
  • endAt: Scheduled end time of the task in ISO 8601 format.
  • name: Name of the task.
  • assigneeIds: List of user IDs assigned to the task.
  • recurrenceRule: Details about task recurrence (if applicable).
  • stepId: Identifier for a specific step in a larger workflow (if applicable).
  • actionId: Identifier for an associated action (if applicable).

Response Example​

The server's response to the webhook indicates successful receipt. A typical response payload might look like this:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_EXPIRED",
   "createdAt": "2024-12-16T09:43:01.347Z",
   "data": {
      "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T09:00:00.000Z",
      "endAt": "2024-12-16T09:43:00.000Z",
      "name": "Task 2",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": null,
      "actionId": null
   },
   "id": 201
}

Benefits of TASK_EXPIRED Webhook​

  1. Improved Oversight: Enables proactive management of overdue tasks.
  2. Automation Opportunities: Can trigger notifications, escalation workflows, or follow-up actions.
  3. Real-Time Updates: Helps maintain task accountability and visibility.

By leveraging the TASK_EXPIRED webhook, organizations can enhance task monitoring and address overdue tasks effectively.